home *** CD-ROM | disk | FTP | other *** search
/ Netware Super Library / Netware Super Library.iso / zipfiles / a2c / bt515.exe / BTRREQ / BTRREQ.TXT
Text File  |  1993-06-24  |  18KB  |  461 lines
  1. Filename: BTRREQ.TXT
  2. Product:  Btrieve v6.1x Requesters for DOS, Windows, OS/2, & UnixWare
  3. Date:     March 1993
  4.  
  5. ===========================================================================
  6. Disclaimer
  7. ==========
  8.  
  9.    Novell, Inc. makes no representations or warranties with respect to
  10.    any NetWare software, and specifically disclaims any express or implied
  11.    warranties of merchantability, title, or fitness for a particular purpose.
  12.  
  13.    Distribution of any NetWare software is forbidden without the express
  14.    written consent of Novell, Inc. Further, Novell reserves the right to
  15.    discontinue distribution of any NetWare software.
  16.  
  17.    Novell is not responsible for lost profits or revenue, loss of use of
  18.    the software, loss of data, costs of re-creating lost data, the cost
  19.    of any substitute equipment or program, or claims by any party other
  20.    than you. Novell strongly recommends a backup be made before any
  21.    software is installed. Technical support for this software may be
  22.    provided at the discretion of Novell.
  23.  
  24. ===========================================================================
  25. Contents
  26. ========
  27.  
  28.    File Information
  29.    Installation & Compatibility
  30.    Upgrade File Descriptions
  31.    Using the Requesters
  32.       DOS Requester
  33.       OS/2 Requester
  34.       Windows Requester
  35.  
  36. ===========================================================================
  37. File Information
  38. ================
  39.  
  40. Filename:  BTRREQ.EXE
  41.  
  42. Date:      6/24/93
  43.  
  44. Files Included:
  45. BTRREQ   TXT     This file
  46.  
  47. \DOS
  48. BREQUTIL EXE     21775 01-30-93  12:32p
  49. BREQUEST EXE     59604 05-13-93   4:48p
  50. BREQUTIL MSG       974 01-30-93  12:32p
  51. BREQUEST MSG      1180 05-13-93   4:48p
  52.  
  53. \OS2
  54. NWLOCALE DLL     34480 05-18-93   1:00p
  55. NDBCNVT  EXE     18192 01-29-93   1:40p
  56. NDBCOMM  DLL     20343 01-29-93   4:16p
  57. BTRCALLS DLL     17944 06-11-93   9:32a
  58.  
  59. \UNIXWARE
  60. LIBBTRV  A       21432 02-05-93   6:08p
  61. LIBBTRV  SO      18268 02-05-93   6:08p
  62. LIBCOMM  A       19120 02-05-93   6:08p
  63. LIBCOMM  SO      18596 02-05-93   6:08p
  64. BTRUNIX  TXT     12231 06-24-93   2:22p
  65. UNXCBTRV O        1420 11-30-92  11:40a
  66.  
  67. \WIN
  68. NWLOCALE DLL     38800 05-18-93   1:00p
  69. WNDBCNVT EXE     30926 01-30-93  12:08p
  70. NOVDB    INI      2460 11-06-92  10:48a
  71. WBTRVRES DLL     22912 01-30-93  12:16p
  72. WBTRCALL DLL     13131 05-13-93   4:00p
  73.  
  74. ===========================================================================
  75. Installation & Compatibility
  76. ============================
  77.  
  78. The Btrieve 6.1x Requesters can be used with the following NLMs and VAPs:
  79.  
  80.         Btrieve NLM v5.15
  81.         Btrieve VAP v5.15
  82.         Btrieve NLM v6.0x
  83.         Btrieve NLM v6.1x
  84.  
  85. To install the requesters, simply replace the existing requester with the
  86. new requester contained with this update.
  87.  
  88. ===========================================================================
  89. Upgrade File Descriptions
  90. =========================
  91.  
  92.   BTRREQ.TXT           This README file
  93.  
  94.    - Files related to DOS workstation operations:
  95.  
  96.      BREQUEST.EXE    Btrieve Requester for DOS.
  97.  
  98.      BREQUEST.MSG    Message file for BREQUEST.EXE.
  99.  
  100.      BREQUTIL.EXE    Btrieve Requester utility that allows you to
  101.                      stop the Requester and to obtain the Requester's
  102.                      version number at a DOS workstation.
  103.  
  104.      BREQUTIL.MSG    Message file for BREQUTIL.EXE.
  105.  
  106.  
  107.    - Files related to Windows workstation operations:
  108.  
  109.      WBTRCALL.DLL    Btrieve Requester for Windows.
  110.  
  111.      WBTRVRES.DLL    Resource file for the Btrieve Windows Requester.
  112.  
  113.      WNDBCNVT.EXE    Windows Conversion utility that converts the
  114.                      client-based Btrieve DLL (WBTRCALL.DLL) to
  115.                      WBTRLOCL.DLL.
  116.  
  117.      NOVDB.INI       Btrieve initialization file for the Btrieve
  118.                      Windows Requester.
  119.  
  120.      NWLOCALE.DLL    National Language Support DLL for the NetWare v3.11
  121.                      environment. Note that the WIN and the OS2
  122.                      directories each contain a different NWLOCALE.DLL.
  123.  
  124.  
  125.    - Files related to OS/2 workstation operations:
  126.  
  127.      BTRCALLS.DLL    Btrieve Requester for OS/2.
  128.  
  129.      NDBCOMM.DLL     Communications handler for the Btrieve
  130.                      Requester for OS/2.
  131.  
  132.      NDBCNVT.EXE     OS/2 Conversion utility that converts the
  133.                      client-based Btrieve DLL (BTRCALLS.DLL) to
  134.                      BTRLOCL.DLL.
  135.      NWLOCALE.DLL    National Language Support DLL for the NetWare v3.11
  136.                      environment. Note that the WIN and the OS2
  137.                      directories each contain a different NWLOCALE.DLL.
  138.  
  139.  
  140.    - Files related to UnixWare workstation operations:
  141.  
  142.      LIBBTRV.A       Archive Btrieve Interface Library.
  143.  
  144.      LIBCOMM.A       Archive Communications Interface Library.
  145.  
  146.      LIBBTRV.SO      Shared-object Btrieve Interface Library.
  147.  
  148.      LIBCOMM.SO      Shared-object Communications Interface Library.
  149.  
  150.      UNXCBTRV.O      C interface object file.
  151.  
  152.      BTRUNIX.TXT     Readme document that describes the Btrieve Requester
  153.                      for UnixWare.
  154.  
  155.  
  156. ===========================================================================
  157. Using the Requesters
  158. ====================
  159.  
  160.    Btrieve provides Requesters for DOS, OS/2, and Windows applications.
  161.    This section provides configuration options and instructions for loading
  162.    and unloading the Requester in each operating environment.
  163.  
  164.    The Btrieve Requesters have changed (primarily in key definition) between
  165.    previous versions and Btrieve v6.x. Therefore, all workstations accessing
  166.    the Btrieve NLM must use the Btrieve v6.x Requesters.
  167.  
  168.  
  169. DOS Requester
  170. -------------
  171.  
  172.    You must load the Btrieve DOS Requester, BREQUEST.EXE, at a workstation
  173.    before that workstation can access network Btrieve files using the Btrieve
  174.    NLM. The DOS Requester loads into a DOS workstation's memory as a Terminate
  175.    and Stay Resident (TSR) program. You can access local as well as remote
  176.    files by running both client-based (local) Btrieve and the Requester at
  177.    your workstation.
  178.  
  179.  
  180. DOS Requester Configuration Options
  181.  
  182.    There are two configuration options for the DOS Requester: Data Message
  183.    Length (/D) and Help (/?). Previous versions of Btrieve supported the /S
  184.    and /R options. Btrieve v6.x accepts the /S and /R options for backwards
  185.    compatibility, but otherwise ignores them.
  186.  
  187.    Data Message Length (/D)
  188.    Range: 532 through 57,000 bytes
  189.    Default: 4,096 bytes
  190.    Memory Required: 538 bytes + data message length
  191.  
  192.    This option specifies the length of the largest record you want to
  193.    access through Btrieve. (If you omit this option, the Requester
  194.    uses the default value, 4,096.) The Requester uses this value to
  195.    calculate the length of the data message buffer reserved for passing
  196.    records between Btrieve and your applications. The Requester maintains
  197.    one copy of the data message buffer.
  198.  
  199.    The value you enter here should not exceed the largest record size
  200.    you configure for Btrieve through the Setup utility since that is the
  201.    maximum message that BSPXCOM can receive.
  202.  
  203.    NOTE:  Specifying a higher value than you need for the /D option
  204.           does not improve performance.
  205.  
  206.    Help (/?)
  207.    The /? option lists the only other option that is used, /D, and
  208.    mentions that although the /S and /R options are for backwards
  209.    compatibility, Btrieve v6.x ignores them.
  210.  
  211.  
  212. Btrieve Requester for DOS -- This Requester has three new
  213.        configuration options.  For detailed information about this
  214.        Requester, refer to Chapter 4 in the "Btrieve Installation
  215.        and Operation" manual.
  216.  
  217.        - NetWare Runtime Server Support (/C) -- Enables or disables
  218.          NetWare Runtime support.
  219.  
  220.        - DOS Session Load (/L) -- Allows you to load another instance
  221.          of the Btrieve DOS Requester even if it is already loaded.
  222.          This option is useful if you want to run Windows applications
  223.          using the Btrieve DOS Requester while running DOS VM
  224.          applications that are also using the Requester.
  225.  
  226.        - Real-Time Data Compression (/O) -- Helps reduce network
  227.          traffic by reducing the number of packets required to
  228.          complete a request to Btrieve.
  229.  
  230.  
  231. Loading the DOS Requester
  232.  
  233.    Load the DOS Requester at the workstation by entering the following
  234.    command:
  235.  
  236.       [path] BREQUEST [/D:dataMsgLength]
  237.  
  238.    path    The pathname to the directory where the DOS Requester is stored.
  239.            You can omit the pathname if the DOS Requester is stored on the
  240.            default drive or if it is located in a directory in your search
  241.            path.
  242.  
  243.    For example, if the Requester is on the default drive and you want to
  244.    specify a 2,048-byte data message length, enter BREQUEST /D:2048.
  245.  
  246.    NOTE:  The forward slash (/) before the configuration option is the
  247.           only valid character you can use. If you specify a dash (-) or
  248.           a backslash (\), the Requester may load improperly.
  249.  
  250.    To ensure that the DOS Requester is always loaded with the /D option set
  251.    to a particular value, place the BREQUEST command in the workstation's
  252.    AUTOEXEC.BAT file.
  253.  
  254.  
  255. Unloading the DOS Requester
  256.  
  257.    At a DOS workstation, you can use two methods to unload the DOS
  258.    Requester:
  259.  
  260.    - Your application can issue a Stop operation (Btrieve
  261.      operation 25).
  262.  
  263.    - You can issue the stop command in the BUTIL utility from the
  264.      workstation's command line.
  265.  
  266.  
  267. OS/2 Requester
  268. --------------
  269.  
  270.    The following files must be loaded in a directory listed in an OS/2
  271.    workstation's LIBPATH before a Btrieve application can access the network
  272.    from that workstation:
  273.  
  274.    BTRCALLS.DLL - the Btrieve dynamic link Requester for OS/2 workstations.
  275.    NDBCOMM.DLL  - the communications Requester for OS/2 workstations.
  276.                   NDBCOMM.DLL provides the necessary data communications between
  277.                   the workstation and the Btrieve NLM.
  278.  
  279.    You can access local as well as remote files by running both client-based
  280.    (local) Btrieve and the Requester at your workstation. If you want to run
  281.    both client-based Btrieve and the Requester, you must use the OS/2
  282.    conversion utility (NDBCNVT.EXE) to convert BTRCALLS.DLL to BTRLOCL.DLL.
  283.    You must type NDBCNVT on the command line to use this utility.
  284.    (By default, the Requester and the client-based Btrieve have the same
  285.    name.)
  286.  
  287.  
  288. OS/2 Requester Configuration Options
  289.  
  290.    You are not required to specify any configuration options for the OS/2
  291.    Requester. Since the internal tables that control the options are not
  292.    fixed, the tables will grow as needed. However, if you prefer to set
  293.    the initial size of the tables, you can do so using the Data Message
  294.    Length (/D) and the Number of Servers (/S) options.
  295.  
  296.    Data Message Length (/D)
  297.    Range: 532 through 65,000 bytes
  298.    Default: 4,096 bytes
  299.    Memory Required: 538 bytes + data message length
  300.  
  301.    The /D option specifies the length of the largest record you want
  302.    to access through Btrieve. The OS/2 Requester uses this value to
  303.    calculate the length of the data message buffer reserved for passing
  304.    records between Btrieve and your applications. The Requester maintains
  305.    one copy of the data message buffer.
  306.  
  307.    The value you enter here should not exceed the value you specified for
  308.    the Largest Record Size configuration option in the Setup utility.
  309.    The value for this option represents the maximum message length that
  310.    BSPXCOM can receive.
  311.  
  312.    NOTE:  Specifying a higher value than you need for the /D option
  313.           does not improve performance.
  314.  
  315.    Number of Servers (/S)
  316.    Range: 1 through 255
  317.    Default: 8
  318.    Memory Required: 27 bytes per server
  319.  
  320.    The /S option specifies the number of servers that have the Btrieve
  321.    NLM active on the network.
  322.  
  323.    NOTE:  The forward slash (/) before the configuration option is the only
  324.           valid character you can use. If you specify a dash (-) or a backslash
  325.           (\), the Requester may load improperly.
  326.  
  327.  
  328.    Btrieve Requester for OS/2 -- This Requester also provides Runtime
  329.        Server support.  For detailed information about the Btrieve
  330.        OS/2 Requester, refer to Chapter 4 in the "Btrieve Installation
  331.        and Operation" manual.
  332.  
  333.  
  334. Configuring the OS/2 Requester
  335.  
  336.    Set the Requester configuration options using the following command:
  337.  
  338.       SET BRQPARMS=/D:dataMsgLength /S:numberOfServers
  339.  
  340.    Do not include a space between BRQPARMS and the equal sign. You can,
  341.    however, insert a space between each configuration option you specify.
  342.  
  343.  
  344. Loading the OS/2 Requester
  345.  
  346.    An application may load the Btrieve for OS/2 Requester in one of the
  347.    following two ways:
  348.  
  349.    Implicitly - Your application can implicitly load the OS/2 Requester
  350.    by either linking with the import library BTRCALLS.LIB or by specifying
  351.    imported functions in the application definition file. If your
  352.    application uses this method, the operating system loads the OS/2
  353.    Requester automatically when the application is started.
  354.  
  355.    Explicitly - Your application can load the OS/2 Requester explicitly
  356.    using the operating system API functions. When the application loads
  357.    the Requester explicitly, the operating system does not load the OS/2
  358.    Requester until notified to do so.
  359.  
  360.  
  361. Unloading the OS/2 Requester
  362.  
  363.    At an OS/2 workstation, the operating system removes the dynamic link
  364.    routines from memory when the application terminates or when the
  365.    application explicitly unloads the OS/2 Requester using the operating
  366.    system API.
  367.  
  368.    Logging out of one or more servers from a workstation does not close
  369.    Btrieve files or terminate the Btrieve SPX connection to the server.
  370.    To close files and terminate the connection, you must either issue a
  371.    STOP command or reboot the server.
  372.  
  373.  
  374. Windows Requester
  375. -----------------
  376.  
  377.    In the Windows environment, you must load the DOS Requester, BREQUEST.EXE,
  378.    before starting Windows. Windows-based Btrieve applications access the
  379.    Requester by means of a DLL, WBTRCALL.DLL, which uses the DOS Protected
  380.    Mode Interface (DPMI) that Windows provides.
  381.  
  382.    The Windows Requester (that is, WBTRCALL.DLL) is the Btrieve interface DLL
  383.    for Windows v3.x. The DLL provides the same API as client-based Btrieve
  384.    and requires no modification to the application.
  385.  
  386.    You can access local as well as remote files by running both client-based
  387.    (local) Btrieve and the Requester at your workstation. If you want to run
  388.    both client-based Btrieve and the Requester, you must run the Windows
  389.    Conversion utility (WNDBCNVT.EXE) to convert WBTRCALL.DLL to WBTRLOCL.DLL.
  390.    You must type WNDBCNVT on the command line to use this utility.
  391.  
  392. Windows Requester Configuration Options
  393.  
  394.    The following list describes the available configuration options for
  395.    the Windows Requester. These options should be specified in the NOVDB.INI
  396.    file under [brequestDPMI].
  397.  
  398.    NOVDB.INI is the Novell initialization file for the Windows Requester.
  399.  
  400.    Tasks = #            Specifies how many concurrent tasks may use the
  401.                         Windows Requester. The default value for this
  402.                         configuration option is 10.
  403.    Local = Yes/No       Instructs the Windows Requester to use client-based
  404.                         Btrieve for accessing files locally. The default
  405.                         value for this configuration option is No.
  406.    Chkparms = Yes/No    Instructs the Windows Requester to validate pointers
  407.                         passed to it. You should use this option only
  408.                         during development. The default value for this
  409.                         configuration option is No.
  410.    Free Memory = Yes/No Allocates and frees real-mode memory on each
  411.                         request. The Windows Requester uses a buffer of
  412.                         real-mode memory to communicate with the DOS
  413.                         Requester. Since real-mode memory is a scarce
  414.                         resource in Windows, your application should
  415.                         not retain it long term.The default value for this
  416.                         configuration option is No.
  417.  
  418.                         NOTE:  Specifying Yes to the Free Memory option
  419.                                degrades performance.
  420.  
  421.  
  422. Loading the Windows Requester
  423.  
  424.    The DOS Requester must be loaded before the Windows Requester can load.
  425.    An application may load the Windows Requester in one of the following two
  426.    ways:
  427.  
  428.    Implicitly - Your application can implicitly load the Btrieve Requester
  429.    by either linking with the import library WBTRCALL.LIB or by specifying
  430.    imported functions in the application definition file. When an
  431.    application loads a DLL implicitly, the operating system automatically
  432.    loads the DLL when the application is started.
  433.  
  434.    Explicitly - Your application may load the Windows Requester explicitly
  435.    using the operating system API functions. The operating system does not
  436.    load the DLL until notified to do so.
  437.  
  438.  
  439. Unloading the Windows Requester
  440.  
  441.    At a Windows workstation, the operating system removes the dynamic link
  442.    routines from memory when the application terminates or when the
  443.    application explicitly unloads the DLLs using the operating system API.
  444.  
  445.  
  446.    NOTE:  Logging out of one or more servers from a workstation does not
  447.           close Btrieve files or terminate the Btrieve SPX connection
  448.           to the server. To close files and terminate the connection,
  449.           you must either issue a STOP command or reboot the server.
  450.           A Reset operation does not terminate the SPX connection.
  451.  
  452.  
  453. UnixWare Requester
  454. ------------------
  455. For infomormation regarding the Btrieve UnixWare requester, see the
  456. file BTRUNX.TXT.
  457.  
  458. ========================================================================
  459. ** End of BTRREQ.TXT **
  460.  
  461.